Skip to content

refactor: add sync generator for zod2md tooling setup#1188

Open
BioPhoton wants to merge 37 commits intomainfrom
chore/add-plugin-for-build
Open

refactor: add sync generator for zod2md tooling setup#1188
BioPhoton wants to merge 37 commits intomainfrom
chore/add-plugin-for-build

Conversation

@BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Dec 15, 2025 •
edited
Loading

preconditions:

This PR implements:

  • handle zod2md dependencies if zod2md.config.js is present

Usage

nx sync --check # log status
nx sync # sync projets

Example project structure

Root/
├── libs/
│   └── project-name/
│       ├── zod2md.config.ts        🔎 triggers the sync generator
│       ├── project.json            👈 checks targets + build.dependsOn
│       ├── tsconfig.lib.json       👈 configures zod2md-jsdocs TS plugin
│       └── src/
│           └── index.ts
└── ...

Targeted behavior summary

  • ✔ No zod2md.config.ts → project is ignored
  • ✔ Missing TS plugin config → patched automatically
  • ✔ Missing Zod2Md target → added automatically
  • ✔ Missing build.dependsOn entries → updated automatically
  • ✔ Fully configured project → no changes, no errors

@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling labels Dec 15, 2025
@nx-cloud
Copy link

nx-cloud bot commented Dec 15, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 22b2fb8

Command Status Duration Result
nx run ci:code-pushup -- merge-diffs --files=/h... ✅ Succeeded 5s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 1m 32s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 13m 7s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2026-02-04 00:40:07 UTC

@nx-cloud
Copy link

nx-cloud bot commented Dec 15, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 58b3eea

☁️ Nx Cloud last updated this comment at 2025-12-15 14:28:22 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 15, 2025 •
edited
Loading

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1188

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1188

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1188

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1188

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1188

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1188

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1188

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1188

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1188

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1188

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1188

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1188

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1188

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1188

commit: 22b2fb8

@github-actions
Copy link
Contributor

github-actions bot commented Dec 15, 2025 •
edited
Loading

Code PushUp

🥳 Code PushUp report has improved – compared current commit f47aacb with previous commit 7b6e72c.

💼 Project utils

🥳 Code PushUp report has improved.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Documentation 🟡 61 🟡 61 ↑ +0.1

5 other categories are unchanged.

👍 1 group improved

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
JSDocs coverage Documentation coverage 🟡 61 🟡 61 ↑ +0.1

14 other groups are unchanged.

🛡️ Audits

All of 444 audits are unchanged.

💼 Project plugin-lighthouse

🤨 Code PushUp report has both improvements and regressions.

🕵️ See full comparison in Code PushUp portal 🔍

All of 6 categories are unchanged.

1 audit changed without impacting score

🗃️ Groups

All of 15 groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Code coverage Branch coverage 🟩 98.8 % 🟩 98.8 % ↓ −0.1 %

443 other audits are unchanged.

12 other projects are unchanged.

This was referenced Dec 15, 2025
Merged
Open
@BioPhoton
Merge branch 'main' into chore/add-plugin-for-build
66b25e6 
# Conflicts:
#	nx.json
#	package-lock.json
#	tools/zod2md-jsdocs/project.json
@BioPhoton
refactor: setup ts plugin
6cc5a33
@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026 •
edited
Loading

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 5a9df5d with previous commit 7b6e72c.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 33 🔴 37 ↑ +4
Bug prevention 🟡 75 🟡 75 ↓ −0.2
Code coverage 🟢 93 🟢 92 ↓ −0.2
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Code style 🟢 100 🟢 100 –
Security 🔴 47 🔴 47 –
Updates 🟡 78 🟡 78 –
Type Safety 🟡 67 🟡 67 –
Miscellaneous 🟡 67 🟡 67 –
Documentation 🟡 53 🟡 53 –
Accessibility 🟢 92 🟢 92 –
Best Practices 🟢 100 🟢 100 –
SEO 🟢 92 🟢 92 –
👍 1 group improved, 👎 2 groups regressed, 👍 4 audits improved, 👎 6 audits regressed, 15 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🔴 33 🔴 37 ↑ +4
ESLint Problems 🟢 100 🟢 99 ↓ −0.7
Code coverage Code coverage metrics 🟢 93 🟢 92 ↓ −0.2

31 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Minify CSS 🟩 0 🟥 Potential savings of 10 KiB ↑ +∞ %
Lighthouse Initial server response time was short 🟥 Root document took 620 ms 🟩 Root document took 500 ms ↓ −19.9 %
ESLint Enforce specific import styles per module. 🟩 passed 🟥 1 warning ↑ +∞ %
Lighthouse Total Blocking Time 🟥 3,150 ms 🟥 1,490 ms ↓ −52.5 %
Lighthouse Speed Index 🟥 7.3 s 🟥 6.6 s ↓ −10.4 %
Lighthouse First Contentful Paint 🟥 3.1 s 🟥 3.3 s ↑ +6.1 %
Lighthouse Time to Interactive 🟥 14.2 s 🟥 13.5 s ↓ −5.5 %
Code coverage Line coverage 🟩 92.8 % 🟩 92.5 % ↓ −0.3 %
Code coverage Branch coverage 🟨 89.2 % 🟨 89 % ↓ −0.2 %
Code coverage Function coverage 🟩 94.4 % 🟩 94.2 % ↓ −0.2 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,087 KiB 🟩 Total size was 2,114 KiB ↑ +1.3 %
Lighthouse Minimizes main-thread work 🟥 13.9 s 🟥 9.1 s ↓ −34.2 %
Lighthouse JavaScript execution time 🟥 4.6 s 🟥 2.8 s ↓ −39.1 %
Lighthouse Metrics 🟩 100% 🟩 100% ↓ −5.5 %
Lighthouse Largest Contentful Paint 🟥 11.7 s 🟥 12.2 s ↑ +4.8 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 125 KiB 🟥 Potential savings of 146 KiB ↑ +50 %
Lighthouse Max Potential First Input Delay 🟥 1,190 ms 🟥 900 ms ↓ −24.4 %
Lighthouse Server Backend Latencies 🟩 640 ms 🟩 860 ms ↑ +36 %
Lighthouse Network Round Trip Times 🟩 10 ms 🟩 70 ms ↑ +950.2 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 225 KiB 🟥 Potential savings of 225 KiB ↓ −0.8 %
TypeScript Semantic errors 🟥 43 errors 🟥 47 errors ↑ +9.3 %
JS packages Outdated npm prod dependencies. 🟨 19 outdated package versions (5 major, 11 minor, 3 patch) 🟨 21 outdated package versions (5 major, 12 minor, 4 patch) ↑ +10.5 %
Lighthouse ARIA tooltip elements have accessible names 🟩 passed 🟩 0 ↓ −100 %
Axe ARIA hidden element must not be focusable or contain focusable elements 🟩 201 elements 🟩 202 elements ↑ +0.5 %

654 other audits are unchanged.

@github-actions github-actions bot added 🧩 cli 🧩 core and removed 📖 Project documentation improvements or additions to the project documentation labels Jan 19, 2026
@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation and removed 🧩 lighthouse-plugin 🧩 coverage-plugin 🧩 ci labels Jan 25, 2026
@BioPhoton BioPhoton changed the title refactor: add task derivation for build refactor: add sync generator for zod2md tooling setup Jan 25, 2026
@BioPhoton BioPhoton marked this pull request as ready for review February 3, 2026 17:50
@BioPhoton
refactor: wip
dd2fc25
@BioPhoton
refactor: wip
3dea723
@BioPhoton
refactor: wip
8a4a584
@BioPhoton
fix(nx-plugin): fix Windows path handling in materializeTree
22b2fb8 
- Fix path.join issue with absolute paths starting with '/'
- This resolves nx workspace root detection issues on Windows
@BioPhoton
Copy link
Collaborator Author

BioPhoton commented Feb 4, 2026

@matejchalk to be able to use uncompiled Nx tooling code we can't have .js extensions present. The reason is, Nx uses SWC under the hood and can't be configured.

Here we see the existing plugin does not have any import to local files: https://github.com/code-pushup/cli/blob/main/tools/zod2md-jsdocs/src/nx-plugin.ts otherwise it fails.

Any other ideas? 💡 how should we progress here other than avoiding extensions?

@matejchalk
Copy link
Collaborator

matejchalk commented Feb 4, 2026

how should we progress here other than avoiding extensions?

Removing import extensions would break our package builds. That's not worth it for a nice-to-have local tool.

If there's no way to tell Nx to look up a matching .ts file for .js imports, then I guess the next best option is build the plugin and run it from dist.

@matejchalk
Copy link
Collaborator

matejchalk commented Feb 4, 2026 •
edited
Loading

... no way to tell Nx to look up a matching .ts file for .js imports ...

💡 Actually, I think I've found a way. We can set a custom Node loader using environment variables. I've tested it locally by adding a constants.ts that's imported as ./constants.js, then running nx graph. This gave me a Cannot find module './constants.js' error, until the .env.local, which fixed it. (See #1238) 🙂

@matejchalk matejchalk mentioned this pull request Feb 4, 2026
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matejchalk matejchalk Awaiting requested review from matejchalk

@hanna-skryl hanna-skryl Awaiting requested review from hanna-skryl

At least 1 approving review is required to merge this pull request.

Assignees

@BioPhoton BioPhoton

Labels

📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@BioPhoton @matejchalk